Class RenameUpload

Summary

Fully Qualified Name: Laminas\Filter\File\RenameUpload
Extends: AbstractFilter

Description

Methods

Name Description Defined By
__construct() Constructor RenameUpload
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Laminas\Filter\Filter RenameUpload
getOptions() Retrieve options representing object state AbstractFilter
getOverwrite() RenameUpload
getRandomize() RenameUpload
getStreamFactory() RenameUpload
getTarget() RenameUpload
getUploadFileFactory() RenameUpload
getUseUploadExtension() RenameUpload
getUseUploadName() RenameUpload
hasPcreUnicodeSupport() AbstractFilter
setOptions() AbstractFilter
setOverwrite() RenameUpload
setRandomize() RenameUpload
setStreamFactory() RenameUpload
setTarget() RenameUpload
setUploadFileFactory() RenameUpload
setUseUploadExtension() RenameUpload
setUseUploadName() RenameUpload

Method Details

__construct()

Constructor

Parameter Name Type Description
$targetOrOptions array|string The

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

Defined by Laminas\Filter\Filter

Renames the file $value to the new name set before Returns the file $value, removing all but digit characters

Parameter Name Type Description
$value string|array|\UploadedFileInterface Full

Returns: string|array|\UploadedFileInterface Returns one of the following: - New filename, for string $value - Array with tmp_name and name keys for array $value - UploadedFileInterface for UploadedFileInterface $value

getOptions()

Retrieve options representing object state

Returns: array

getOverwrite()

Returns: bool

getRandomize()

Returns: bool

getStreamFactory()

Returns: null|\StreamFactoryInterface

getTarget()

Returns: string Target file path or directory

getUploadFileFactory()

Returns: null|\UploadedFileFactoryInterface

getUseUploadExtension()

Returns: bool

getUseUploadName()

Returns: bool

hasPcreUnicodeSupport()

Returns: bool

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

setOverwrite()

Parameter Name Type Description
$flag bool Shall

Returns: self

setRandomize()

Parameter Name Type Description
$flag bool Shall

Returns: self

setStreamFactory()

Parameter Name Type Description
$factory \StreamFactoryInterface Factory

Returns: self

setTarget()

Parameter Name Type Description
$target string Target

Returns: self

setUploadFileFactory()

Parameter Name Type Description
$factory \UploadedFileFactoryInterface Factory

Returns: self

setUseUploadExtension()

Parameter Name Type Description
$flag bool When

Returns: self

setUseUploadName()

Parameter Name Type Description
$flag bool When

Returns: self

Top